/**
 *  Copyright (C) 2008-2013  Telosys project org. ( http://www.telosys.org/ )
 *
 *  Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *          http://www.gnu.org/licenses/lgpl.html
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.telosys.common.val;

import java.math.BigDecimal;

/**
 * This class wraps a BigDecimal value in an mutable value object. 
 * The current value can be changed with the 'setValue' method.
 * 
 * @author Laurent Guerin
 */
public class BigDecimalValue implements ISingleValue
{
	private static final long serialVersionUID = 1L;

	private final static BigDecimal ZERO = new BigDecimal(0.0);
    
    private BigDecimal _value = ZERO ;
        
    //-----------------------------------------------------------------------------------
    
    /**
     * Default constructor, the initial value is '0.0'.
     */
    public BigDecimalValue () 
    {
        _value = ZERO ;
    }
    
    /**
     * Constructor with initial value, if the parameter is null, the value is set to '0.0'
     * @param v
     */
    public BigDecimalValue ( BigDecimal v ) 
    {
        _value = ( v != null ? v : ZERO ) ;
    }
    
    //-----------------------------------------------------------------------------------

    /**
     * Change the current value
     * @param v
     */
    public void setValue(BigDecimal v)
    {
        _value = v;
    }
    
    /**
     * Returns the BigDecimal instance
     * ( the value returned is never null )
     * @return
     */
    public BigDecimal getValue()
    {
        return ( _value != null ? _value : ZERO ) ;
    }
    
    //-----------------------------------------------------------------------------------
    
    public String toString()
    {
        return ( _value != null ? _value.toString() : "0.0" ) ;
    }
    
}
